
VIRTUAL MAX CHAT VERSION 4 PARAMETERS- http://vmax.netfx.com

Features: 
  
- Nested room structure with unlimited depth 
- Public and Private (password protected) rooms
- Public, Private and Pager message modes
- User Filtering
- Custom background image, colors and layout
  
Room structure:

The chat structure is organized like a file structure on your computer, rooms 
are folders and users are files. Each room can contain child rooms and users 
in it, users can move easy through this structure using different ways: 
either click on a room to enter child room or exit to one level up, or type 
the location in location field and jump directly to destination room. 
Visitors can create rooms that will exist until the last visitor leaves,as 
soon as last visitor leaves, this room will be automatically deleted. Top 
level rooms are created by the server with names specified in configuration 
file, those rooms are 'static' rooms and won't be deleted when last user 
leaves it. 

Public and Private Rooms: 

When the user creates a room, he can optionally set a password for it. When 
another visitor tries to enter the protected room, he will be prompted for 
password. Direct jumping over a protected room by typing destination in 
location field is impossible, the intruder will be stopped on the previous 
level and prompted for a password. 

Message Modes:

There are three basic modes 
  
Public message
This will be broadcasted to all users in the current room. To send a 
public message, select 'All' in users list. 

Private message
To send a private message, select recipient in users list. The message input 
field will change it's color to indicate the private mode of submission. This
message will be sent only to the selected user and copied back to sender. 
This mode works only for users who are in the current room. 

Pager mode 
This is the same as private message, but it requires you to type in the 
recipients name and the message will be delivered to the recipient with the 
specified name in ANY room. A copy of the message will be sent back to you, 
but you have no confirmation that it was actually delivered or not. 
  

Names:

Each user can specify his nickname when he enters the chat. Your name can 
contain only alphanumeric characters. When the user logs in, the server will
check for this name among already logged users, so the same name can't be 
used twice, this eliminates problems with identification. Room names also can 
contain only alphanumeric characters. The server won't allow you to create 
two child rooms with the same name inside one parent room. 

Filtering:

Each user has the ability to set-up filters against any other user in chat. 
There are two separate filters for input and output channels. For example, 
I can set input filter(s), so that I won't accept messages sent by some other
user(s), and I can set filter(s) on the output channel, so that messages I
send to all wouldn't reach the filtered user(s). These two separate filters 
based on capturing user IP and adding it to my filter lists, so even if this 
other user were to logout and reenter with another different nickname he will 
still remain filtered out. 

Custom Outlook:

This applet has a lot of parameters, this makes is possible to totally change 
the outlook and layout of components to fit any web site design. In general, 
this applet contains one background image and numerous icons images and 
ruler images. A specially designed set of transparent components (lists 
labels and main message area) significantly simplifies the outlook design. 
All colors for client applet are also defined as parameters. Below is an 
example of an applet tag, as it used in above example. Applet also includes 
some set of audio clips to be played on events in chat. 

<APPLET CODE="vmaxchatclient.class" CODEBASE="../chatserver" WIDTH=580 HEIGHT=360> 
<PARAM NAME="FONT"                 VALUE="dialog,1,10"> 
<PARAM NAME="TEXTCOLOR"            VALUE="ffffff"> 
<PARAM NAME="FROMCOLOR"            VALUE="ffffff"> 
<PARAM NAME="BGCOLOR"              VALUE="000000"> 
<PARAM NAME="LISTHLCOLOR"          VALUE="000080"> 
<PARAM NAME="BUTTONHLCOLOR"        VALUE="ffffff"> 
<PARAM NAME="BUTTONCOLOR"          VALUE="5c6c7c"> 
<PARAM NAME="BUTTONTEXTCOLOR"      VALUE="000000"> 
<PARAM NAME="PRIVATECOLOR"         VALUE="000080"> 
<PARAM NAME="LOGIMAGE"             VALUE="/chat/chat2/chatlog2.gif"> 
<PARAM NAME="BGIMAGE"              VALUE="/chat/chat2/bgimage2.gif"> 
<PARAM NAME="ROOMICONS"            VALUE="newroom.gif,uproom.gif,room.gif,proom.gif"> 
<PARAM NAME="USERICONS"            VALUE="user.gif,nruser.gif,nsuser.gif,nsnruser.gif"> 
<PARAM NAME="RULLERS"              VALUE="ruller.gif,pruller.gif,sruller.gif,eruller.gif"> 
<PARAM NAME="LOCATIONRECT"         VALUE="89,28,300,16"> 
<PARAM NAME="ROOMSRECT"            VALUE="455,29,100,135"> 
<PARAM NAME="USERSRECT"            VALUE="455,203,100,329"> 
<PARAM NAME="INPUTRECT"            VALUE="13,329,425,16"> 
<PARAM NAME="DISPLAYRECT"          VALUE="17,59,425,252"> 
<PARAM NAME="EXITRECT"             VALUE="390,31,41,16"> 
<PARAM NAME="MODEPOINT"            VALUE="-10,-50"> 
<PARAM NAME="CLIPS"                VALUE="s09.au,s14.au,s25.au,s20.au,s38.au,s39.au,s52.au,s53.au"> 
<PARAM NAME="WELCOME"              VALUE="Welcome to Virtual Max Chat Network \nIf you need help type /h in message field."> 
<PARAM NAME="HELP"                 VALUE="--------------------------------------------------------------------------------------------------------------------------------------- \n 
-                                           Welcome to Virtual Max Help                                           - \n
--------------------------------------------------------------------------------------------------------------------------------------- \n 
1) Help - Type in /h in the message field for this page. \n\n 
2) Private Messages - Click user to send a private message. \n\n
3) Pager Messages - Click pager and fill in the field with the recipients nick name. \n\n
4) Ignore Users - Click on user and turn them off by clicking the ear. \n\n
5) Create a Room - By clicking on New Room and entering the information. \n
--------------------------------------------------------------------------------------------------------------------------------------- \n\n">
<PARAM NAME="AUTHOR"               VALUE="Virtual_Max (http://vmax.netfx.com)"> 
<PARAM NAME="PORT"                 VALUE="1000">
</APPLET>


All colors are in hexadecimal RRGGBB format, same as HTML colors are, but 
WITHOUT # radix symbol. Below is a brief explanations of parameters

TEXTCOLOR	- main text color used in all elements of applet for particular text

FROMCOLOR	- color used to write sender name over message separators 

BGCOLOR 	- main applet background color

LISTHLCOLOR	- color to highlight selected items in lists

BUTTONCOLOR	- color for button background

BUTTONTEXTCOLOR - button text color (any doubts?) 

BUTTONHLCOLOR 	- button text highlight color for mouse over button

PRIVATECOLOR    - Color for background of message input field in private and pager mode

BGIMAGE 	- applet background image, with all elements of outlook

ROOMICONS   	- set of icon images for rooms list, below is set of icons used in this applet
		  newroom.gif,  uproom.gif, room.gif,  proom.gif 

USERICONS  	- 4 icons reflecting 4 states of input/output filter 
    		  user.gif, nruser.gif, nsuser.gif,  nsnruser.gif 


LOCATIONRECT , ROOMSRECT, USERSRECT, INPUTRECT, DISPLAYRECT, EXITRECT 
Are "left,top,width,height" rectangles to layout applet components over 
applet background. 

MODEPOINT this is pivot point to reflect mode ( private or pager ) as a text 
label, this label dosen't fit well in the above design, so it is moved out 
(to negative coordinates) of the applet visible area. But probably one would 
like to use it. 

CLIPS are list of Sun's .au format audio files to be played on different 
events, like users login, logout, rooms creation and removing, message, pager
and private message comes. (Optional parameter) 

WELCOME this is a text of welcome message for the applet, it shows once, the 
user login chat the first time. 

HELP help message, you can type here whatever you like. Both parameters 
support '\n' as new line. 

AUTHOR is obligatory parameter and can't be changed. 

Key in vmaxserver.cfg file    	
Your generated key we make for you goes here, do not put a param on the chat page, put your 
key in the .cfg file or it will not work and turn your chat into trial version with up to 10 
concurrent users.

Port 		
This will coincide with each chat page you will setup for each server, both
the param port and the server port in the .cfg file must be the same or the 
chat client will not work with that server.
  
Server Notes:

Server is written as Java Application. and requires JRE 1.x or JDK 1.x 
JRE (Java Runtime Environment) and JDK (Java Developers Kit) are distributed 
free by Sun Microsystems. To run the server you need to install JRE or JDK or
any other java1.1 runtime and start the server typing from command prompt. 

Win32 platform users: 
>java vmaxserver 
Unix platform user can do this typing: 
>nohup java vmaxserver >server.log & 

One probably would like to edit list of top level room names in vmaxserver
.cfg file. The syntax is easy, each line of this file contains the Room Name 
and Room Password separated by a space. Room Password is optional. 

Below is example of vmaxserver.cfg file 
  
maxusers: 600
key: -123-136-50-148-71-135-12-14310135
masterpassword: joeshmoe 

port: 1000
userlimit: 250
room: Teens
room: Over_20
room: Over_30
room: Over_40
room: Over_50

port: 1001
userlimit: 250
room: Teens
room: Over_20
room: Over_30
room: Over_40
room: Over_50

port: 1002
userlimit: 250
room: Teens
room: Over_20
room: Over_30
room: Over_40
room: Over_50

end:

Key in above example should match the server IP address and maxusers number, 
otherwize the server will work as a trial version with limitation of max 
users simultaniously connected to server. 

Free version of server allows only 10 users simultaniously logged. For free
use key line can be omited. 

For more information on setup and parameter setup refer to the setup.txt file
in this package.

For tech support go to: http://vmax.netfx.com



